Foxit PDF SDK
静态 Public 成员函数 | 所有成员列表
FoxitPDFSDKPython3.PDF2Office类 参考
类 FoxitPDFSDKPython3.PDF2Office 继承关系图:
FoxitPDFSDKPython3.Base

静态 Public 成员函数

def GetVersion ()
 获取Foxit PDF转换SDK的版本。 更多...
 
def Initialize (library_path, fx_engine_path)
 初始化Foxit PDF转换。 更多...
 
def Release ()
 释放Foxit PDF转换分配的所有资源。 更多...
 
def SetConvertCheckCallback (convert_check_callback)
 设置检查PDF到Office转换条件的回调对象。 更多...
 
def StartConvertToExcel (src_pdf_path, src_pdf_password, saved_excel_file_path, setting_data, convert_callback)
 开始将PDF文件转换为Excel格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。 更多...
 
def StartConvertToExcel (src_pdf_reader, src_pdf_password, saved_excel_file_stream, setting_data, convert_callback)
 开始将PDF文件转换为Excel格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。 更多...
 
def StartConvertToPowerPoint (src_pdf_path, src_pdf_password, saved_ppt_file_path, setting_data, convert_callback)
 开始将PDF文件转换为PowerPoint格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。 更多...
 
def StartConvertToPowerPoint (src_pdf_reader, src_pdf_password, saved_ppt_file_stream, setting_data, convert_callback)
 开始将PDF文件转换为PowerPoint格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。 更多...
 
def StartConvertToWord (src_pdf_path, src_pdf_password, saved_word_file_path, setting_data, convert_callback)
 开始将PDF文件转换为Word格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。 更多...
 
def StartConvertToWord (src_pdf_reader, src_pdf_password, saved_word_file_stream, setting_data, convert_callback)
 开始将PDF文件转换为Word格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。 更多...
 

详细描述

此类可用于将PDF文件转换为Office（Word、Excel或PowerPoint）格式文件。 在使用"转换"模块之前，请确保Foxit PDF转换SDK包中名为"res"和"lib"的资源文件夹有效。 在使用此模块中的方法之前，请确保Foxit PDF SDK已通过函数FoxitPDFSDKPython3.Library.Initialize 使用包含"PDF2Office"模块的密钥成功初始化。

参见
FoxitPDFSDKPython3.Library

成员函数说明

◆ GetVersion()

FoxitPDFSDKPython3.PDF2Office.GetVersion ( )
static

获取Foxit PDF转换SDK的版本。

此函数应在函数FoxitPDFSDKPython3.PDF2Office.Initialize 成功调用后调用。

返回
包含Foxit PDF转换SDK版本信息的字符串。

◆ Initialize()

FoxitPDFSDKPython3.PDF2Office.Initialize (   library_path,
  fx_engine_path 
)
static

初始化Foxit PDF转换。

在"PDF2Office"模块的生命周期内，此函数只能调用一次， 并且应在"PDF2Office"模块中任何其他函数被调用之前首先调用。

参数
[in]library_pathFoxit PDF转换SDK库的路径。这不应该是空字符串。
[in]fx_engine_pathFoxit PDF转换引擎的路径。可以是空字符串。如果参数 为空，PDF转换SDK库将直接调用进行PDF到Office转换， 否则Foxit PDF转换SDK库将通过Foxit PDF转换引擎调用进行PDF到Office转换。
返回
无。
注解
如果在函数FoxitPDFSDKPython3.Library.Initialize 中使用的许可证信息中未定义模块"PDF2Office"， 这意味着用户没有使用PDF2Office相关函数的权限， 此函数将抛出异常FoxitPDFSDKPython3.e_ErrNoPDF2OfficeModuleRight 。

◆ Release()

FoxitPDFSDKPython3.PDF2Office.Release ( )
static

释放Foxit PDF转换分配的所有资源。

当用户不使用"pdf2office"模块时，应调用此函数释放库分配的所有内存块。

返回
无。

◆ SetConvertCheckCallback()

FoxitPDFSDKPython3.PDF2Office.SetConvertCheckCallback (   convert_check_callback)
static

设置检查PDF到Office转换条件的回调对象。

此方法允许您指定一个自定义转换检查回调，当转换PDF文档所需的权限不满足时， 将调用该回调来评估是否应继续从PDF到Office的转换，基于用户定义的逻辑。

参数
[in]convert_check_callback基于回调类ConvertCheckCallback 实现的自定义转换检查回调。 如果这是null，自定义转换检查回调将被删除，改为使用默认转换检查。
注解
当通过函数FoxitPDFSDKPython3.PDF2Office.Initialize 设置Foxit PDF转换引擎时，ConvertCheckCallback将不起作用， 它将使用内部ConvertCheckcallbacks来允许转换。
返回
true表示成功，而false表示失败。

◆ StartConvertToExcel() [1/2]

FoxitPDFSDKPython3.PDF2Office.StartConvertToExcel (   src_pdf_path,
  src_pdf_password,
  saved_excel_file_path,
  setting_data,
  convert_callback 
)
static

开始将PDF文件转换为Excel格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。

目前仅支持转换为XLSX格式文件。

参数
[in]src_pdf_pathPDF文件的路径。这不应该是空字符串。
[in]src_pdf_password输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
[in]saved_excel_file_path作为转换结果保存的Excel格式文件的路径。这不应该是空字符串。 如果保存的Excel格式文件的后缀名不是"xlsx"，将在原文件名后添加新的后缀"xlsx"。
[in]setting_data用于转换的设置数据。如果PDF2OfficeSettingData 对象的参数page_range 为空，这意味着将PDF文件的每一页都转换为Excel格式文件。
[in]convert_callback由用户实现的FoxitPDFSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以是null，意味着不暂停和通知转换进度。 如果这不是null，它应该是由用户实现的有效FoxitPDFSDKPython3.ConvertCallback 对象。
默认值：null。
返回
一个渐进对象。请通过函数FoxitPDFSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。 FoxitPDFSDKPython3.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython3.Progressive.Continue to continue the progress until the progress is finished.
注解
当通过函数FoxitPDFSDKPython3.PDF2Office.Initialize 设置Foxit PDF转换引擎时，ConvertCallback将不起作用。

◆ StartConvertToExcel() [2/2]

FoxitPDFSDKPython3.PDF2Office.StartConvertToExcel (   src_pdf_reader,
  src_pdf_password,
  saved_excel_file_stream,
  setting_data,
  convert_callback 
)
static

开始将PDF文件转换为Excel格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。

目前仅支持转换为XLSX格式文件。

参数
[in]src_pdf_reader由用户实现的FileReaderCallback 对象， 用于加载PDF文档。它不应该是null。
[in]src_pdf_password输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
[in]saved_excel_file_stream由用户实现的FoxitPDFSDKPython3.StreamCallback 对象， 用于读取转换后Excel格式文件的内容。它不应该是null。
[in]setting_data用于转换的设置数据。如果PDF2OfficeSettingData 对象的参数page_range 为空，这意味着将PDF文件的每一页都转换为Excel格式文件。
[in]convert_callback由用户实现的FoxitPDFSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以是null，意味着不暂停和通知转换进度。 如果这不是null，它应该是由用户实现的有效FoxitPDFSDKPython3.ConvertCallback 对象。
默认值：null。
返回
一个渐进对象。请通过函数FoxitPDFSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。 如果速率还不是100，调用函数FoxitPDFSDKPython3.Progressive.Continue 继续进度直到进度完成。
注解
当通过函数FoxitPDFSDKPython3.PDF2Office.Initialize 设置Foxit PDF转换引擎时，ConvertCallback将不起作用。

◆ StartConvertToPowerPoint() [1/2]

FoxitPDFSDKPython3.PDF2Office.StartConvertToPowerPoint (   src_pdf_path,
  src_pdf_password,
  saved_ppt_file_path,
  setting_data,
  convert_callback 
)
static

开始将PDF文件转换为PowerPoint格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。

目前仅支持转换为PPTX格式文件。

参数
[in]src_pdf_pathPDF文件的路径。这不应该是空字符串。
[in]src_pdf_password输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
[in]saved_ppt_file_path作为转换结果保存的PowerPoint格式文件的路径。这不应该是空字符串。 如果保存的PowerPoint格式文件的后缀名不是"pptx"，将在原文件名后添加新的后缀"pptx"。
[in]setting_data用于转换的设置数据。如果PDF2OfficeSettingData 对象的参数page_range 为空，这意味着将PDF文件的每一页都转换为PowerPoint格式文件。
[in]convert_callback由用户实现的FoxitPDFSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以是null，意味着不暂停和通知转换进度。 如果这不是null，它应该是由用户实现的有效FoxitPDFSDKPython3.ConvertCallback 对象。
默认值：null。
返回
一个渐进对象。请通过函数FoxitPDFSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。 如果速率还不是100，调用函数FoxitPDFSDKPython3.Progressive.Continue 继续进度直到进度完成。
注解
当通过函数FoxitPDFSDKPython3.PDF2Office.Initialize 设置Foxit PDF转换引擎时，ConvertCallback将不起作用。

◆ StartConvertToPowerPoint() [2/2]

FoxitPDFSDKPython3.PDF2Office.StartConvertToPowerPoint (   src_pdf_reader,
  src_pdf_password,
  saved_ppt_file_stream,
  setting_data,
  convert_callback 
)
static

开始将PDF文件转换为PowerPoint格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。

目前仅支持转换为PPTX格式文件。

参数
[in]src_pdf_reader由用户实现的FileReaderCallback 对象， 用于加载PDF文档。它不应该是null。
[in]src_pdf_password输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
[in]saved_ppt_file_stream由用户实现的FoxitPDFSDKPython3.StreamCallback 对象， 用于读取转换后PowerPoint格式文件的内容。它不应该是null。
[in]setting_data用于转换的设置数据。如果PDF2OfficeSettingData 对象的参数page_range 为空，这意味着将PDF文件的每一页都转换为PowerPoint格式文件。
[in]convert_callback由用户实现的FoxitPDFSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以是null，意味着不暂停和通知转换进度。 如果这不是null，它应该是由用户实现的有效FoxitPDFSDKPython3.ConvertCallback 对象。
默认值：null。
返回
一个渐进对象。请通过函数FoxitPDFSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。 如果速率还不是100，调用函数FoxitPDFSDKPython3.Progressive.Continue 继续进度直到进度完成。
注解
当通过函数FoxitPDFSDKPython3.PDF2Office.Initialize 设置Foxit PDF转换引擎时，ConvertCallback将不起作用。

◆ StartConvertToWord() [1/2]

FoxitPDFSDKPython3.PDF2Office.StartConvertToWord (   src_pdf_path,
  src_pdf_password,
  saved_word_file_path,
  setting_data,
  convert_callback 
)
static

开始将PDF文件转换为Word格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。

目前仅支持转换为DOCX格式文件。

参数
[in]src_pdf_pathPDF文件的路径。这不应该是空字符串。
[in]src_pdf_password输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
[in]saved_word_file_path作为转换结果保存的Word格式文件的路径。这不应该是空字符串。 如果保存的Word格式文件的后缀名不是"docx"，将在原文件名后添加新的后缀"docx"。
[in]setting_data用于转换的设置数据。如果PDF2OfficeSettingData 对象的参数page_range 为空，这意味着将PDF文件的每一页都转换为Word格式文件。
[in]convert_callback由用户实现的FoxitPDFSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以是null，意味着不暂停和通知转换进度。 如果这不是null，它应该是由用户实现的有效FoxitPDFSDKPython3.ConvertCallback 对象。
默认值：null。
返回
一个渐进对象。请通过函数FoxitPDFSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。 如果速率还不是100，调用函数FoxitPDFSDKPython3.Progressive.Continue 继续进度直到进度完成。
注解
当通过函数FoxitPDFSDKPython3.PDF2Office.Initialize 设置Foxit PDF转换引擎时，ConvertCallback将不起作用。

◆ StartConvertToWord() [2/2]

FoxitPDFSDKPython3.PDF2Office.StartConvertToWord (   src_pdf_reader,
  src_pdf_password,
  saved_word_file_stream,
  setting_data,
  convert_callback 
)
static

开始将PDF文件转换为Word格式文件。必须在调用此函数之前调用函数FoxitPDFSDKPython3.PDF2Office.Initialize 。

目前仅支持转换为DOCX格式文件。

参数
[in]src_pdf_reader由用户实现的FileReaderCallback 对象， 用于加载PDF文档。它不应该是null。
[in]src_pdf_password输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
[in]saved_word_file_stream由用户实现的FoxitPDFSDKPython3.StreamCallback 对象， 用于读取转换后Word格式文件的内容。它不应该是null。
[in]setting_data用于转换的设置数据。如果PDF2OfficeSettingData 对象的参数page_range 为空，这意味着将PDF文件的每一页都转换为Word格式文件。
[in]convert_callback由用户实现的FoxitPDFSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以是null，意味着不暂停和通知转换进度。 如果这不是null，它应该是由用户实现的有效FoxitPDFSDKPython3.ConvertCallback 对象。
默认值：null。
返回
一个渐进对象。请通过函数FoxitPDFSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。 如果速率还不是100，调用函数FoxitPDFSDKPython3.Progressive.Continue 继续进度直到进度完成。
注解
当通过函数FoxitPDFSDKPython3.PDF2Office.Initialize 设置Foxit PDF转换引擎时，ConvertCallback将不起作用。